docs(readme): clarify required environment variables in quickstart #44
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When apt resolves a newer containerd.io version from Docker's repository metadata but the .deb file is not yet available (or temporarily missing) on the Docker CDN, the install fails with 404 errors. This adds a fallback strategy that: 1. Attempts the normal Docker install (unchanged behavior) 2. If it fails, refreshes apt metadata and enumerates available versions 3. Retries installation by pinning each available version (newest to oldest) This handles transient Docker repo/CDN sync issues gracefully without hard-coding a specific containerd version.
The quickstart step 3 only mentioned GitHub App credentials and domains, but users also need to configure: - LE_EMAIL (required for Let's Encrypt SSL certificates) - EMAIL_SENDER_ADDRESS and RESEND_API_KEY (required for login emails and invitations) This updates the quickstart to explicitly list all required environment variables so users don't miss critical configuration.
Owner
I'm probably gonna update the docs myself and merge the other fix you had for just docker. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The quickstart step 3 in README.md only mentioned "GitHub App credentials and domains" but users also need to configure several other required environment variables.
Changes
Updated the quickstart instructions to explicitly list all required configuration:
GITHUB_APP_*)APP_HOSTNAME,DEPLOY_DOMAINLE_EMAIL(for Let's Encrypt notifications)EMAIL_SENDER_ADDRESS,RESEND_API_KEY(for login emails and invitations)Why
Without this clarification, users following the quickstart would miss critical env vars like
LE_EMAIL,EMAIL_SENDER_ADDRESS, andRESEND_API_KEY, causing the service to fail on startup with validation errors.The environment variables table further down in the README already documents all variables, but step 3 didn't make it clear which ones are required vs optional.